home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / raae10.zip / RAAE.DOC next >
Encoding:
Text File  |  1990-07-05  |  10.9 KB  |  276 lines
  1.  
  2.  
  3.  
  4.  
  5.          
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                            [*]    RAAE    [*]
  14.  
  15.                                Version  1.0 
  16.  
  17.                    (C) Copyright 1990, By Randall Edwards 
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.                                DISCLAIMER 
  28.                                ----------
  29.  
  30.               The program RAAE.EXE and this documentation are the
  31.          copyrighted property of Randall Edwards. All rights, except 
  32.          those outlined in this document, are reserved. 
  33.  
  34.               By using this software you acknowledge that this 
  35.          software may not suit your particular needs or be completely 
  36.          trouble free.  Use this program at your own risk. 
  37.  
  38.               In no event will Randall Edwards be liable for any 
  39.          damages, including any lost profits, lost savings or other 
  40.          incidental or consequential damages arising out of the use of 
  41.          or inability to use these programs, even if Randall Edwards 
  42.          has been advised of the possibility of such damages. 
  43.  
  44.               In short, there's absolutely no guarantees with this 
  45.          program.  Use it at your own risk.  If you break it, you can 
  46.          have both pieces. 
  47.  
  48.  
  49.  
  50.  
  51.                           CREDIT WHERE CREDIT IS DUE 
  52.                           ---------------------------
  53.  
  54.               Thanks to Adam Hudson, who wrote the orignal QuickBBS 
  55.          program which led to RemoteAccess.  Thanks also to the 
  56.          RemoteAccess authors for their innovative work in BBS's. 
  57.  
  58.               Thanks to P.J. Muller who wrote a library for QuickBBS 
  59.          which I arrogantly hacked apart and modified in order to come 
  60.          up with routines to use in this program. 
  61.  
  62.               I give credit to the Taiwanese, who for near-slave wages 
  63.          produced this computer that this program was written on.  By 
  64.          allowing companies based in the United States to steal their 
  65.          labor and the profits from their hard work, I have the wealth 
  66.          and time to 'play' around with this machine and to write 
  67.          programs like this.  They have only their near-slave wages, 
  68.          terrible working conditions, and my appreciation and hope 
  69.          that they can overcome obstacles in their way and achieve 
  70.          full social justice. 
  71.          
  72.  
  73.  
  74.  
  75.                              PURPOSE AND USAGE 
  76.                              -----------------
  77.           
  78.               RAAE is a program to enter a message into
  79.          RemoteAccess' message base.  RAAE will convert a text
  80.          file into a message from the Sysop and to whoever the Sysop 
  81.          specifies or optionally to "All" users.
  82.  
  83.  
  84.  
  85.  
  86.               RAAE stands for "RemoteAccess Auto-Enter."  It is 
  87.          pronounced like "ray" or "rae" as in "Norma Rae" that famous 
  88.          union working lady played by Sally Field in the movie of the 
  89.          same name.  Smart, cute AND a determined union member?!
  90.          That's my kind of lady!  
  91.          
  92.               RAAE is dedicated to all the exploited workers of the 
  93.          world and to all workers struggling to form unions to get a 
  94.          fair share of the profits they themselves create. 
  95.          
  96.  
  97.               RAAE uses the following command line parameters:
  98.          
  99.          RAAE <BoardNumber> <FileSpec> [FirstName] [LastName]
  100.          
  101.               "BoardNumber" is a number 1-200 which tells RAAE to
  102.          put the message in a specific message area or "board" in 
  103.          RemoteAccess' message base.
  104.          
  105.               "FileSpec" is the name of a text file that will be 
  106.          converted into the message that RAAE generates.  This
  107.          parameter can contain an option drive/path specification.  
  108.          For instance, FILE.TXT and C:\TEMP\FILE.TXT are equally 
  109.          valid.  This text file should be plain ASCII text with no 
  110.          lines longer than 79 characters.
  111.          
  112.               "FirstName" and "LastName" are two optional parameters.  
  113.          If one or both are given then the message is address to that 
  114.          person.  If neither the "FirstName" or "LastName" parameters 
  115.          are given, then the message will default as To: All.
  116.  
  117.               All messages generated by RAAE are listed as From:
  118.          <Sysop Name> where the "Sysop Name" is the name listed in 
  119.          RemoteAccess' CONFIG.RA file.  The Sysop's name is specified 
  120.          in the RACONFIG program.  In my case this would read: 
  121.  
  122.          From: Randy Edwards 
  123.          
  124.               All messages have the subject set to "Auto-Enter Message 
  125.          From <Sysop Name>".  Where Sysop Name is the name specified 
  126.          in RACONFIG's CONFIG.RA file.  Again, in my case this would 
  127.          look like: 
  128.  
  129.          Subj: Auto-Enter Message From Randy Edwards 
  130.          
  131.  
  132.               To run the program just specify the proper parameters.  
  133.          For example:
  134.          
  135.          RAAE 1 C:\RA\TEST.MSG John Doe
  136.          
  137.          would create a message in board number 1 with the text from 
  138.          C:\RA\TEST.MSG and address it to John Doe. 
  139.  
  140.  
  141.  
  142.          RAAE 50 ECHO.RUL
  143.          
  144.          would create a message in board number 50 with the text from 
  145.          the file ECHO.RUL in the default directory, and address it to 
  146.          All. 
  147.  
  148.               RAAE will add a tear line to all messages it generates.  
  149.          If the board that it is posting a message into is an echomail 
  150.          board, as defined in the MESSAGES.RA file, then RAAE will 
  151.          also add the correct * Origin: line and node address that is 
  152.          specified for use with that message board. 
  153.  
  154.               There are many ways to use RAAE.  For instance, I 
  155.          moderate the ANEWS echo, an echo of alternative news, and I 
  156.          post the rules to ANEWS in the echo once a month on the first 
  157.          day of the month.  I use RAAE like this: 
  158.          
  159.           ErrorLvl DOM        <-- This determines the day of the month
  160.           IF ErrorLevel 2 GOTO START       <-- restarts the batch file
  161.           RAAE 10 C:\MISC\ANEWS.RUL        <-- run RAAE
  162.           IF ErrorLevel 1 TSUtil Index     <-- check for a RAAE error
  163.          
  164.               This sequence would create a message in ANEWS with the 
  165.          rules to the echo on the 1st of every month.  The message 
  166.          would be to "All" contain the text from C:\MISC\ANEWS.RUL.
  167.          
  168.               Another ingenious use of RAAE is to greet new users
  169.          to your system.  For instance, the top lines of the file 
  170.          NEWUSER2.ASC of my system contains the following:
  171.          
  172.           Please Wait ... 
  173.           ^XC:\UTILS\RAAE.EXE 1 C:\MISC\NEWUSER.MSG *F *L|
  174.          
  175.               This sequence runs a shell from a text file (the 
  176.          Control-X, ^X) which runs RAAE to generate a welcome
  177.          message in board 1 (my local message area).  RemoteAccess 
  178.          supplies the user's first and last names with the *F and *L 
  179.          macros.  Then during RemoteAccess' sign-on mail check the 
  180.          user will be told that he already has a message waiting (even 
  181.          though it's his first call!).  This has surprised quite a few 
  182.          users on my system.  See your RemoteAccess manual for more 
  183.          information about doing shells from text files. 
  184.          
  185.               I'm sure you'll be able to think up many more uses for 
  186.          RAAE.
  187.          
  188.  
  189.          
  190.  
  191.          NOTES AND WARNINGS 
  192.          ------------------
  193.          
  194.               RAAE was coded for use on a single-line RemoteAccess 
  195.          system.  It contains no code for file-sharing or record-
  196.          locking and it requires sole access to RemoteAccess' message 
  197.          base files. 
  198.  
  199.  
  200.           
  201.               RAAE has been tested extensively, but of course no 
  202.          guarantees are given.  If the program encounters an error it 
  203.          will return an errorlevel of 1.  If the program runs 
  204.          successfully it returns an errorlevel of 0. 
  205.  
  206.               I've never had the program corrupt a message base in 
  207.          testing.  The most common errors are that the text input file 
  208.          cannot be found, the board number is out of range (not 1 to 
  209.          200) and minor things like that.
  210.          
  211.               Because of the potential of a severe error corrupting 
  212.          RemoteAccess' message base, the program, if run from a batch 
  213.          file, the program should be trapped to determine the 
  214.          errorlevel it ends with.  If the program ends with an 
  215.          errorlevel of 1 (an error occured) then you should run a 
  216.          message base packing program to re-create the index files to 
  217.          your message base.  While this is normally not necessary, it 
  218.          is cheap insurance!
  219.          
  220.               For instance, in my batch file I run RAAE like this:
  221.          
  222.           RAAE 10 C:\MISC\ANEWS.RUL
  223.           IF ErrorLevel 1 TSUtil Index
  224.          
  225.          or using QuickBBS' message pack program it'd look like:
  226.          
  227.           RAAE 10 C:\MISC\ANEWS.RUL
  228.           IF ErrorLevel 1 MsgPack -I
  229.          
  230.          This batch file chunk would detect an error and then run the 
  231.          appropriate program to create new index files.
  232.  
  233.               RAAE can be run from any directory.  It checks the
  234.          default directory and the RemoteAccess environment variable 
  235.          RA= to find the CONFIG.RA and MESSAGES.RA files.  Once it 
  236.          finds CONFIG.RA it then reads info such as the directory to 
  237.          where the message base is located, the Sysop's name, node 
  238.          numbers, and things like that.  From MESSAGES.RA it reads the 
  239.          type of board that it is to work on -- Local, Netmail or 
  240.          Echomail -- and which node number and origin line to use. 
  241.          Failure to find any of these files -- the message base files, 
  242.          CONFIG.RA and MESSAGES.RA --will cause an error. 
  243.          
  244.  
  245.  
  246.  
  247.           VERSION HISTORY 
  248.           --------------- 
  249.           
  250.          1.0 - Initial public release. 
  251.  
  252.  
  253.  
  254.  
  255.                                 LICENSE 
  256.                                 -------
  257.          
  258.               It's free.  If you like it use it.  If you don't like it 
  259.          then erase it from your disk(s) and forget all about it.  
  260.          
  261.               The only persons and/or organizations that are 
  262.          specifically forbidden to use this program are anyone 
  263.          employed by the Department of Defense and/or the National 
  264.          Security Agency of the United States Government. 
  265.          
  266.               Please don't modify and then redistribute the program 
  267.          and/or documentation.  
  268.          
  269.               Suggestions and bug reports may be sent to Randy Edwards 
  270.          at the Socialism OnLine! BBS at 1-203-274-4639, 300-14400 bps
  271.          HST, FidoNet 1:141/552.0 or Good Egg Net 99:9300/552.0. 
  272.  
  273.               Trademarks mentioned in this document are probably 
  274.          registered to their respective owners. 
  275.  
  276.